Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Advance RFC #0860 "EmberData | Request Service" to Stage Recommended #942

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Advance RFC #0860 "EmberData | Request Service" to Stage Recommended #942

wants to merge 2 commits into from

Conversation

emberjs-rfcs-bot
Copy link
Collaborator

@emberjs-rfcs-bot emberjs-rfcs-bot commented Jul 28, 2023 •
edited by runspired
Loading

Advance #860 to the Recommended Stage

Summary

This pull request is advancing the RFC to the Recommended Stage.

An FCP is required before merging this PR to advance.

Recommended Stage Summary

The "Recommended" stage is the final milestone for an RFC. It provides a signal to the wider community to indicate that a feature has been put through its ecosystem paces and is ready to use.

To reach the "Recommended" stage, the following should be true:

If appropriate, the feature is integrated into the tutorial and the guides prose. API documentation is polished and updates are carried through to other areas of API docs that may not directly pertain to the feature.

If the proposal replaces an existing feature, the addon ecosystem has largely updated to work with both old and new features.

If the proposal updates or replaces an existing feature, high-quality codemods are available.

If needed, Ember debugging tools as well as popular IDE support have been updated to support the feature.

If the feature is part of a suite of features that were designed to work together for best ergonomics, the other features are also ready to be "Recommended".

Any criteria for "Recommended" for this proposal that were established in the Ready For Release stage have been met.

An FCP is required to enter this stage. Multiple RFCs may be moved as a batch into "Recommended" with the same PR.

Checklist to move to Recommended

  • Criteria specific to this feature: Any additional criteria for "Recommended" for this proposal that were established in the Ready For Release stage have been met.
  • Tutorial: If appropriate, the feature is integrated into the tutorial.
  • Guides: If appropriate, the feature is integrated into the guides prose.
  • API Docs: API documentation is polished and updates are carried through to other areas of API docs that may not directly pertain to the feature.
  • Addon Ecosystem: If the proposal replaces an existing feature, the addon ecosystem has largely updated to work with both old and new features.
  • Codemods: If the proposal updates or replaces an existing feature, high-quality codemods are available.
  • Debugging Tools: If needed, Ember debugging tools (e.g. Ember Inspector, Deprecation Workflow) have been updated to support the feature.
  • IDE Support: If needed, popular IDE support has been updated to support the feature.
  • Engines, SSR: If needed, ecosystem feature such as Ember Engines, SSR support have been updated to support the feature.
  • Blueprints: Blueprints have been updated to support the feature and to reflect the new best practices implied by this feature.
  • Linting: Lint rules have been updated or added or removed to support the feature and to reflect the new best practices implied by this feature.
  • Deprecations: If this feature implies that other features are no longer best practice, RFCs have been created to deprecate those features.
  • Blog Post: Consider if a blog post should be written to introduce this feature to the community.
  • Feature Suite: If the feature is part of a suite of features that were designed to work together for best ergonomics, the other features are also ready to be "Recommended".
  • FCP to Recommended: This PR has been converted from a draft to a regular PR and the Final Comment Period label has been added to start the FCP.

Criteria for moving to Recommended (required)

A set of criteria for moving this RFC to the Recommended Stage, following release:

Implementation

  • Implementation is complete (4.12)
  • Fetching data has a polished story (5.3)
  • Saving data has a polished story for issuing the request (5.3)
  • [-] Non RequestManager request APIs are deprecated not a blocker for recommended, separate RFC

Documentation

  • API Documentation exists (4.12)
  • Package Documentation exists (4.12)
  • [-] Async Relationships in EmberData can be handled by the RequestManager for someone using the recommended experience (requires new decorators or SchemaModel) not a blocker for recommended, separate update

Learning

  • Examples of writing effective handlers exist
  • Guides no longer recommend Adapters/Serializers
  • Ember Tutorial no longer uses Adapters/Serializers
  • Guides no longer shows usage of store.findRecord|query|queryRecord|findAll and record.save|destroyRecord
  • Ember Tutorial no longer shows usage of store.findRecord|query|queryRecord|findAll and record.save|destroyRecord

@emberjs-rfcs-bot emberjs-rfcs-bot added RFC Advancement S-Recommended PR to move to the Recommended Stage labels Jul 28, 2023
@runspired runspired added T-ember-data RFCs that impact the ember-data library T-learning labels Jul 28, 2023
@ef4
Copy link
Contributor

ef4 commented Sep 1, 2023

At RFC review meeting the data team reported that they're actively tracking this work.

@runspired
Copy link
Contributor

Updated to account for what will release this week in 5.3

@runspired
Copy link
Contributor

We continue to make progress towards recommended. RFC #964 will continue to advance this by focusing on some of the learning story cleanup and deprecating the legacy request methods.

@jenweber jenweber mentioned this pull request Sep 25, 2023
Open
@ef4
Copy link
Contributor

ef4 commented Sep 29, 2023

Latest update:

  • not going to move to recommended until the in-progress newer replacement for async relationships is available
  • API docs exists but tutorial and guides need to be updated

@ef4
Copy link
Contributor

ef4 commented Jan 19, 2024

Latest update: if you're using async relationships you still can't entirely drop the legacy behaviors so we can't go to recommended without that new replacement, which is in the works.

@ef4
Copy link
Contributor

ef4 commented Mar 29, 2024

Latest update: the remaining work here is primarily learning materials.

@runspired
Copy link
Contributor

@Baltazore has begun work on super-rentals and main website guides to bring them to latest

@ef4
Copy link
Contributor

ef4 commented Jun 14, 2024

Can we get a status update on the remaining docs work here?

@Baltazore
Copy link

@ef4 here is the PR for tutorial update ember-learn/super-rentals-tutorial#238
Would work on guides soon

@ef4
Copy link
Contributor

ef4 commented Jun 28, 2024

Status update is that there's ongoing work in both guides and tutorial that is progressing.

@ef4
Copy link
Contributor

ef4 commented Aug 2, 2024

Any updates on the documentation work for this feature?

@ef4
Copy link
Contributor

ef4 commented Oct 18, 2024

I think the last remaining piece here is:

Guides no longer shows usage of store.findRecord|query|queryRecord|findAll and record.save|destroyRecord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@runspired runspired

Labels
RFC Advancement S-Recommended PR to move to the Recommended Stage T-ember-data RFCs that impact the ember-data library T-learning
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@emberjs-rfcs-bot @ef4 @runspired @Baltazore